Skip to content

[clean] Correct release documentation#66

Merged
vikuznetsov-nvidia merged 1 commit into
mainfrom
vikuznetsov/update-release-docs
Jul 22, 2026
Merged

[clean] Correct release documentation#66
vikuznetsov-nvidia merged 1 commit into
mainfrom
vikuznetsov/update-release-docs

Conversation

@vikuznetsov-nvidia

@vikuznetsov-nvidia vikuznetsov-nvidia commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

Align release guidance with the artifacts users can actually install and expose the current map APIs in generated docs.

Summary by CodeRabbit

  • Documentation
    • Added detailed compatibility tables for pre-built wheels and C++ SDK archives.
    • Added instructions for downloading and using version-matched offline API documentation.
    • Clarified installation prerequisites, supported Python/CUDA/platform combinations, and source-build requirements.
    • Expanded troubleshooting guidance for Python API references, wheel compatibility, and multisensor cuNLS requirements.
    • Updated API documentation to include additional tracker methods and improved project wording.

Align release guidance with the artifacts users can actually install and expose the current map APIs in generated docs.
@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Updated release documentation, wheel and C++ archive compatibility tables, cuNLS multisensor requirements, Python API references, Sphinx visibility, and related installation guidance.

Changes

Documentation alignment

Layer / File(s) Summary
Release artifact and wheel guidance
README.md, cuvslam-skills/cuvslam-onboard/SKILL.md, cuvslam-skills/cuvslam-troubleshoot/SKILL.md
Documents offline API archives, target-specific wheel tags, CUDA and architecture requirements, C++ SDK archives, and supported Python versions.
cuNLS multisensor guidance
TROUBLESHOOTING.md, examples/multisensor/README.md, examples/realsense/README.md
Clarifies cuNLS requirements, pinhole-camera support, release-wheel contents, default source-build behavior, and disabled-build limitations.
Python API documentation alignment
TROUBLESHOOTING.md, python/docs/api.rst, python/docs/index.rst
Fully qualifies configuration references, exposes additional Tracker members, and corrects the documentation introduction.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: hrabeti-nvidia, slepichev

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the PR's main goal of updating release and documentation content.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch vikuznetsov/update-release-docs

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@cuvslam-skills/cuvslam-onboard/SKILL.md`:
- Around line 51-61: Add an explicit step in the onboarding flow to download the
matching cuVSLAM wheel from the latest GitHub release before the installation
step that references cuvslam-<version>.whl. Follow the artifact-selection and
download guidance established in README.md, including the required Ubuntu,
architecture, Python, and CUDA wheel tags.

In `@README.md`:
- Line 6: Change the “Latest release” heading in the README from an H3 (`###`)
to an H2 (`##`), preserving its existing links and text.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: f6dd7e14-e888-4108-8a7f-ab641cb60d77

📥 Commits

Reviewing files that changed from the base of the PR and between efd72a3 and c17e72f.

📒 Files selected for processing (8)
  • README.md
  • TROUBLESHOOTING.md
  • cuvslam-skills/cuvslam-onboard/SKILL.md
  • cuvslam-skills/cuvslam-troubleshoot/SKILL.md
  • examples/multisensor/README.md
  • examples/realsense/README.md
  • python/docs/api.rst
  • python/docs/index.rst

Comment thread cuvslam-skills/cuvslam-onboard/SKILL.md
Comment thread README.md
@github-actions

Copy link
Copy Markdown

Test Results

Status Platform Language Total Passed Failed Errors Skipped
Orin C++ 16 16 0 0 0
Orin Python 71 70 0 0 1
Thor C++ 16 16 0 0 0
Thor Python 71 70 0 0 1
x86_64 C++ 16 16 0 0 0
x86_64 Python 71 70 0 0 1

cuVSLAM Evaluation KPIs

Config Dataset ATE,% ARE,º/m Kabsch, Losts, diff ATE,% diff ARE,º/m diff Kabsch, diff Losts, FPS,Hz
x86_64-cuda12.6.3-ubuntu24.04 KITTI-STEREO_ODOM 0.8473 0.0024 2.9446 0 NA NA NA NA 298.7
x86_64-cuda12.6.3-ubuntu24.04 KITTI-STEREO_SLAM 0.7574 0.002 1.9345 0 NA NA NA NA 179.0

Artifacts

@vikuznetsov-nvidia
vikuznetsov-nvidia merged commit e14d471 into main Jul 22, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants